Move GtkPrintJob docs inline

diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 2d8d06735a7d1aa0f84bbbe0b9a96ff696d70157..9f143317e73adde8d58b443d50dcbec4a385a72b 100644 (file)
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -45,6 +45,7 @@ gtkpagesetupunixdialog.sgml
 gtkpaned.sgml
 gtkpapersize.sgml
 gtkprinter.sgml
+gtkprintjob.sgml
 gtkprogressbar.sgml
 gtkradioaction.sgml
 gtkradiobutton.sgml

diff --git a/docs/reference/gtk/tmpl/gtkprintjob.sgml b/docs/reference/gtk/tmpl/gtkprintjob.sgml
deleted file mode 100644 (file)
index 09d2681..0000000
--- a/docs/reference/gtk/tmpl/gtkprintjob.sgml
+++ /dev/null
@@ -1,186 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GtkPrintJob
-
-<!-- ##### SECTION Short_Description ##### -->
-Represents a print job
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-A #GtkPrintJob object represents a job that is sent to a
-printer. You only need to deal directly with print jobs if 
-you use the non-portable #GtkPrintUnixDialog API. 
-</para>
-<para>
-Use gtk_print_job_get_surface() to obtain the cairo surface
-onto which the pages must be drawn. Use gtk_print_job_send()
-to send the finished job to the printer. If you don't use cairo
-#GtkPrintJob also supports printing of manually generated postscript,
-via gtk_print_job_set_source_file().
-<!-- FIXME more details needed here -->
-</para>
-<!-- FIXME examples ? -->
-
-<para>
-Printing support was added in GTK+ 2.10.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### STRUCT GtkPrintJob ##### -->
-<para>
-The GtkPrintJob struct contains only private members
-and should not be directly accessed.
-</para>
-
-
-<!-- ##### SIGNAL GtkPrintJob::status-changed ##### -->
-<para>
-
-</para>
-
-@printjob: the object which received the signal.
-
-<!-- ##### ARG GtkPrintJob:page-setup ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkPrintJob:printer ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkPrintJob:settings ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkPrintJob:title ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkPrintJob:track-print-status ##### -->
-<para>
-
-</para>
-
-<!-- ##### USER_FUNCTION GtkPrintJobCompleteFunc ##### -->
-<para>
-The type of callback that is passed to gtk_print_job_send().
-It is called when the print job has been completely sent.
-</para>
-
-@print_job: the #GtkPrintJob
-@user_data: user data that has been passed to gtk_print_job_send()
-@error: a #GError that contains error information if the sending
-  of the print job failed, otherwise %NULL
-
-
-<!-- ##### FUNCTION gtk_print_job_new ##### -->
-<para>
-
-</para>
-
-@title: 
-@printer: 
-@settings: 
-@page_setup: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_print_job_get_settings ##### -->
-<para>
-
-</para>
-
-@job: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_print_job_get_printer ##### -->
-<para>
-
-</para>
-
-@job: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_print_job_get_title ##### -->
-<para>
-
-</para>
-
-@job: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_print_job_get_status ##### -->
-<para>
-
-</para>
-
-@job: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_print_job_set_source_file ##### -->
-<para>
-
-</para>
-
-@job: 
-@filename: 
-@error: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_print_job_get_surface ##### -->
-<para>
-
-</para>
-
-@job: 
-@error: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_print_job_send ##### -->
-<para>
-
-</para>
-
-@job: 
-@callback: 
-@user_data: 
-@dnotify: 
-
-
-<!-- ##### FUNCTION gtk_print_job_set_track_print_status ##### -->
-<para>
-
-</para>
-
-@job: 
-@track_status: 
-
-
-<!-- ##### FUNCTION gtk_print_job_get_track_print_status ##### -->
-<para>
-
-</para>
-
-@job: 
-@Returns: 
-
-

diff --git a/gtk/gtkprintjob.c b/gtk/gtkprintjob.c
index d96af1ed48825af458061df6fc4096cc1369e69e..d37e1221a91ecc88f85257891afb1c55d7d4fa20 100644 (file)
--- a/gtk/gtkprintjob.c
+++ b/gtk/gtkprintjob.c
@@ -17,6 +17,21 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:gtkprintjob
+ * @Title: GtkPrintJob
+ * @Short_description: Represents a print job
+ *
+ * A #GtkPrintJob object represents a job that is sent to a
+ * printer. You only need to deal directly with print jobs if
+ * you use the non-portable #GtkPrintUnixDialog API.
+ *
+ * Use gtk_print_job_get_surface() to obtain the cairo surface
+ * onto which the pages must be drawn. Use gtk_print_job_send()
+ * to send the finished job to the printer. If you don't use cairo
+ * #GtkPrintJob also supports printing of manually generated postscript,
+ * via gtk_print_job_set_source_file().
+ */
 #include "config.h"
 #include <stdlib.h>
 #include <string.h>

diff --git a/gtk/gtkprintjob.h b/gtk/gtkprintjob.h
index 89668a5c7e3bf463c73c8bc0db807a5a0e8ba3ea..d09004a63f1875468c1e6e0629e4895945b0c125 100644 (file)
--- a/gtk/gtkprintjob.h
+++ b/gtk/gtkprintjob.h
@@ -42,6 +42,16 @@ typedef struct _GtkPrintJob          GtkPrintJob;
 typedef struct _GtkPrintJobClass     GtkPrintJobClass;
 typedef struct _GtkPrintJobPrivate   GtkPrintJobPrivate;
 
+/**
+ * GtkPrintJobCompleteFunc:
+ * @print_job: the #GtkPrintJob
+ * @user_data: user data that has been passed to gtk_print_job_send()
+ * @error: a #GError that contains error information if the sending
+ *     of the print job failed, otherwise %NULL
+ *
+ * The type of callback that is passed to gtk_print_job_send().
+ * It is called when the print job has been completely sent.
+ */
 typedef void (*GtkPrintJobCompleteFunc) (GtkPrintJob  *print_job,
                                          gpointer      user_data,
                                          const GError *error);